Skip to main content

Quick Start - ZIP

If you don't have an access to internal repository then this is a guide how to install dxCharts packages without it.

Get ZIP​

dxchart5-modules, dxchart5-react and dxstudies packages most commonly are distributed via ZIP file (it could be trial version or some other special version, it doesn't matter).

This is an approx content of a ZIP:

  • /dxcharts_lib_5.5.0.zip
    • /dxchart5-modules
    • /dxchart5-react
    • /dxstudies

Setup your application​

There is a lot of ways how you can setup your application, to startup we recommend via create-react-app or npm create vite.

We highly recommend to use typescript, because dxcharts is fully typed, and it could be much easier to get into it.

Install packages from ZIP via local packages feature​

npm and yarn have a mechanism to install local packages.

Run these commands in your project root folder:

# assuming ../dxchart.lib folder is UNZIPPED chart package
npm install ../dxchart.lib/dxchart5-modules
npm install ../dxchart.lib/dxstudies
npm install ../dxchart.lib/dxchart5-react
# or yarn@3.x.x (it's also available in the older versions, but the syntax may be different)
yarn add ../dxchart.lib/dxchart5-modules
yarn add ../dxchart.lib/dxstudies
yarn add ../dxchart.lib/dxchart5-react

After those commands the packages should be installed locally. Your package.json file should look something like that:

{
	//...
	"dependencies": {
		"@dx-private/dxchart5-modules": "./dxchart.lib/dxchart5-modules",
		"@dx-private/dxchart5-react": "./dxchart.lib/dxchart5-react",
		"@dx-private/dxstudies": "./dxchart.lib/dxstudies"
		//...
	}
}

dxCharts is a library so it has dependencies as well, including peer dependencies which should be installed. So you need to run:

npm install
# or yarn
yarn install

Install react and react-dom​

dxchart5-react has react and react-dom packages as a peerDependencies, so to make library work you need to install those packages in your project, if you don't have them.

dxchart5-react library works only with "react": "17.x.x" and "react-dom": "17.x.x" or higher

npm install --save react react-dom
# or yarn
yarn add react react-dom

Congratulations! All the preparations are complete! Now you are ready to use dxchart5-react library.

How to use dxchart5-react library

If you use React please follow the guide for React based applications.

If your choice is Vue you can check the guide for Vue based applications.

If you like Angular you can check the guide for [[Quick Start - Angular|Angular based applications]].

If you prefer vanilla or another not so widely used frameworks you'll find useful Vanilla guide.